mudbox::LayerContainer Class Reference

#include <layer.h>

Inheritance diagram for mudbox::LayerContainer:

[legend] List of all members.

---

Detailed Description

This class contains and manages a list of Layers.

Public Member Functions
virtual const mudbox::ClassDesc *	RuntimeClass (void) const
virtual unsigned int	LayerCount (void) const
	Returns the number of layers in the container.
virtual class Layer *	Layer (unsigned int iLayerIndex) const
	Returns a pointer to a contained layer, based on its index in the list.
virtual unsigned int	LayerIndex (class Layer *pLayer) const
	Returns the index of the specified layer in the container. If the layer in not in the container, either -1 or a value equal to LayerCount() will be returned.
virtual void	UnlinkLayer (class Layer *pLayer)
	Removes a layer from the container. The layer is not deleted.
virtual void	AddLayer (class Layer *pLayer)
	Adds a new layer to the container.
virtual class Layer *	CreateLayer (void)
	Creates a new layer and returns a pointer to it.
virtual class Layer *	ActiveLayer (void) const
	Returns a pointer to the current (active) layer.
virtual void	SetActiveLayer (class Layer *pLayer)
	Sets the current (active) layer.
virtual void	MoveLayer (class Layer *pLayer, class Layer *pWhere, bool bBefore)
	Moves the layer before or after the specified one in the list.
virtual void	ReparentLayer (class Layer *pLayer, class Layer *pParent)
	Makes this layer as a child of another one.
virtual class Layer *	BaseLayer (void) const
	Returns the base layer.
virtual void	Serialize (Stream &s)
	Reads/writes this object to/from a data stream.
Static Public Member Functions
const mudbox::ClassDesc *	StaticClass (void)
mudbox::Node *	CreateInstances (unsigned int iCount=1)

---

Member Function Documentation

virtual const mudbox::ClassDesc* mudbox::LayerContainer::RuntimeClass (  void   )  const [inline, virtual]

Reimplemented from mudbox::TreeNode. Reimplemented in mudbox::ViewPort. :

const mudbox::ClassDesc* mudbox::LayerContainer::StaticClass (  void   )  [static]

Reimplemented from mudbox::TreeNode. Reimplemented in mudbox::ViewPort.

mudbox::Node* mudbox::LayerContainer::CreateInstances (  unsigned int  iCount = 1  )  [static]

Reimplemented from mudbox::TreeNode. Reimplemented in mudbox::ViewPort.

virtual unsigned int mudbox::LayerContainer::LayerCount (  void   )  const [virtual]

Returns the number of layers in the container. Reimplemented in mudbox::ViewPort.

virtual class Layer* mudbox::LayerContainer::Layer (  unsigned int  iLayerIndex  )  const [virtual]

Returns a pointer to a contained layer, based on its index in the list. Parameters: iLayerIndex  [in] index of the layer to return (0-based) Reimplemented in mudbox::ViewPort.

virtual unsigned int mudbox::LayerContainer::LayerIndex (  class Layer *  pLayer  )  const [virtual]

Returns the index of the specified layer in the container. If the layer in not in the container, either -1 or a value equal to LayerCount() will be returned. Parameters: pLayer  [in] A pointer to the layer whose index you want.

virtual void mudbox::LayerContainer::UnlinkLayer (  class Layer *  pLayer  )  [virtual]

Removes a layer from the container. The layer is not deleted. Parameters: pLayer  [in] A pointer to the layer to be removed Reimplemented in mudbox::ViewPort.

virtual void mudbox::LayerContainer::AddLayer (  class Layer *  pLayer  )  [virtual]

Adds a new layer to the container. Parameters: pLayer  [in] A pointer to the layer to be added Reimplemented in mudbox::ViewPort.

virtual class Layer* mudbox::LayerContainer::CreateLayer (  void   )  [virtual]

Creates a new layer and returns a pointer to it. Reimplemented in mudbox::ViewPort.

virtual class Layer* mudbox::LayerContainer::ActiveLayer (  void   )  const [virtual]

Returns a pointer to the current (active) layer. Reimplemented in mudbox::ViewPort.

virtual void mudbox::LayerContainer::SetActiveLayer (  class Layer *  pLayer  )  [virtual]

Sets the current (active) layer. Parameters: pLayer  [in] A pointer to the layer to be made current Reimplemented in mudbox::ViewPort.

virtual void mudbox::LayerContainer::MoveLayer (  class Layer *  pLayer, class Layer *  pWhere, bool  bBefore )  [virtual]

Moves the layer before or after the specified one in the list. Parameters: pLayer  [in] A pointer to the layer to be moved pWhere  [in] A pointer to the destination bBefore  [in] If true, the layer is moved to immediately before the destination. If false, it is moved to immediately after.

virtual void mudbox::LayerContainer::ReparentLayer (  class Layer *  pLayer, class Layer *  pParent )  [virtual]

Makes this layer as a child of another one. Parameters: pLayer  [in] The layer to move pParent  [in] Its new parent

virtual class Layer* mudbox::LayerContainer::BaseLayer (  void   )  const [virtual]

Returns the base layer.

virtual void mudbox::LayerContainer::Serialize (  Stream &  s  )  [virtual]

Reads/writes this object to/from a data stream. Parameters: s  [in] the data stream Reimplemented from mudbox::TreeNode.

---

mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer

mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer mudbox::LayerContainer